Отслеживание заказа

Запрос позволяет узнать статус заказа и местонахождение машины, которая была назначена заказу.

Синтаксис запроса

GET http://b2b-api.go.yandex.ru/integration/2.0/orders/progress?order_id={идентификатор заказа}

Заголовки запроса

  • Authorization: Bearer <OAuth-токен>
    Процесс получения токена описан в разделе Начало работы.
  • X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос содержит обязательный параметр:

  • order_id — идентификатор отменяемого заказа.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
status Статус заказа. Строка
time_left_raw Время до прибытия водителя или до окончания заказа в секундах. Число
vehicle Информация о местоположении машины. Содержит массив location из двух значений, задающих координаты машины. Строка

Пример запроса

GET http://b2b-api.go.yandex.ru/integration/2.0/orders/progress?order_id=191...280'
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "status": "finished",
  "vehicle": {
    "location": [55.749884, 37.589688]
  }
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 403:
    • SELECT_CLIENT_HEADER_REQUIRED — в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
    • SELECTED_CLIENT_ACCESS_DENIED — в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
  • 404 — заказ не найден.
Предыдущая
Отмена заказа
Следующая
Отзыв о водителе